Configuration Service

TimePunch's configuration service provides methods for reading and/or saving settings in TimePunch.

LoadAttendanceSettings

This method returns the global settings of the Attendance list module.

AttendanceSettingsDto LoadAttendanceSettings(  
 out TpFault fault,  
 TpAuthentication authentication);

Needed Permission	core@logon
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return value		Information about the attendance settings

SaveAttendanceSettings

This method allows you to save the global settings for the Attendance list module.

void SaveAttendanceSettings(  
 out TpFault fault,  
 TpAuthentication authentication,  
 AttendanceSettingsDto attendanceSettings);

Needed Permission	core@administrate
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
attendanceSettings		Information about the attendance settings

LoadCostCenterSettings

This method returns the cost centers defined in TimePunch for the different posting types.

CostCenterDto LoadCostCenterSettings(  
 out TpFault fault,   
 TpAuthentication authentication);

Needed Permission	core@logon
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return value		Information about the cost centers

SaveCostCenterSettings

This method allows you to save the cost centers for the different booking types in TimePunch.

void SaveCostCenterSettings(  
 out TpFault fault,   
 TpAuthentication authentication,   
 CostCenterDto costCenter);

Needed Permission	datev@export
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
costCenter		Information about the cost centers

LoadDatevExportSettings

This method loads the settings for exporting to DATEV.

GlobalSalaryExportDto LoadDatevExportSettings(  
 out TpFault fault,   
 TpAuthentication authentication);

Needed Permission	core@logon
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return value		Information about the datev settings

SaveDatevExportSettings

This method saves the settings for the DATEV export.

void SaveDatevExportSettings(  
 out TpFault fault,   
 TpAuthentication authentication,   
 GlobalSalaryExportDto datevExport);

Needed Permission	datev@export
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
datevExport		Information about the datev settings

LoadMailSettings

This method loads the settings for automatic mail sending in TimePunch.

AutomatedMailsDto LoadMailSettings(  
 out TpFault fault,   
 TpAuthentication authentication);

Needed Permission	core@logon
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return value		Information about the automated mail settings

SaveMailSettings

This method saves the settings for automatic mail sending in TimePunch.

void SaveMailSettings(  
 out TpFault fault,   
 TpAuthentication authentication,   
 MailSettingsDto mailSettings);

Needed Permission	core@administrate
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
mailSettings		Information about the automated mail settings

LoadUserSettings

This method loads settings that affect all users equally and cause a special behavior in TimePunch.

UserSettingsDto LoadUserSettings(  
 out TpFault fault,   
 TpAuthentication authentication);

Needed Permission	core@logon
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return value		User settings object

SaveUserSettings

This method saves the settings for the special behavior in TimePunch.

void SaveUserSettings(  
 out TpFault fault,   
 TpAuthentication authentication,   
 UserSettingsDto userSettings);

Needed Permission	core@administrate
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userSettings		Information about the datev settings

LoadUserSalaryExportDto

This method loads the employee-specific settings for wage data export into a payroll program.

List<UserSalaryExportDto> LoadUserSalaryExportDto(  
 out TpFault fault,   
 TpAuthentication authentication,   
 List<Guid> userIds);

Needed Permission	salaryExport@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
userIds		User Ids to load the salary export dto
Return value		Salary export settings per user

SaveUserSalaryExportDto

This method saves the employee-specific settings for the wage data export.

void SaveUserSalaryExportDto(  
 out TpFault fault,   
 TpAuthentication authentication,   
 List<UserSalaryExportDto> salaryExportDtos);

Needed Permission	core@administrate
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
salaryExportDtos		Salary export settings per user

LoadDocumentStoreConfiguration

This method loads the document store configuration from the application server.

DocumentStoreConfigurationDto LoadDocumentStoreConfiguration(  
 out TpFault fault,   
 TpAuthentication authentication);

Needed Permission	documentStore@access
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return value		Document storage configuration

SaveDocumentStoreConfiguration

This method writes the configuration of the document store in the application server.

void SaveDocumentStoreConfiguration(  
 out TpFault fault,   
 TpAuthentication authentication,   
 DocumentStoreConfigurationDto configuration);

Needed Permission	core@administrate
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
configuration		The document storage configuration

LoadVisualSettings

This method loads the UI settings from TimePunch.

VisualSettingsDto LoadVisualSettings(
 out TpFault fault, 
 TpAuthentication authentication);

Needed Permission	---
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return Value		The visual settings object

SaveVisualSettings

This method saves the UI settings of TimePunch.

void SaveVisualSettings(
 out TpFault fault, 
  TpAuthentication authentication, 
   VisualSettingsDto visualSettings);

Needed Permission	core@administrate
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
visualSettings		The visual settings object

LoadRetroactiveProjectAssignment

This method loads the settings for retrospective project assignment.

RetroactiveProjectAssignmentDto LoadRetroactiveProjectAssignment(
 out TpFault fault, 
 TpAuthentication authentication);

Needed Permission	---
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
Return Value		The retroactive project settings

SaveRetroactiveProjectAssignment

This method saves the settings for retroactive project assignment.

void SaveRetroactiveProjectAssignment(
 out TpFault fault, 
  TpAuthentication authentication, 
   RetroactiveProjectAssignmentDto RetroactiveProjectAssignment);

Needed Permission	core@administrate
Name	Modifier	Description
fault	Out	Contains the error if an exception occurs.
authentication		User authentication
RetroactiveProjectAssignment		The retroactive project settings object